home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / apps / other / phem2.lzh / PHEM2.DOC < prev    next >
Encoding:
Text File  |  1995-02-21  |  19.9 KB  |  552 lines

  1. Probe House Software presents
  2.  
  3.         Probe House  E x p e n s e   M a n a g e r   v 2 . 0
  4.  
  5.                     William Wong, Feb 1995
  6.  
  7.                     Probe House Software
  8.  
  9.     * Introduction
  10.     * The Concept of PHEM
  11.     * Installation
  12.     * The Menu Bar
  13.     * Transaction Report Generator
  14.     * Account Report / Category Report Generator
  15.     * Budget Report and Budget List
  16.     * How to Find/Search for a particular transaction
  17.     * Account List & Category List and Merge
  18.     * Transaction Entry
  19.     * The Report Toolbar
  20.     * Calendar Window
  21.     * Reindex, System Info and Configure Window
  22.     * The GUI and Key shortcuts.
  23.     * Creating a New Book.
  24.     * Development, History, acknowledgement, address
  25.  
  26.   PHEM is freeware - you can freely use and distribute it. If you
  27.   like it, please let me know as it is a booster for software developer.
  28.   Donations and gifts are welcome.
  29.  
  30. Introducting PHEM
  31. =================
  32. The Probe House Expense Manager or PHEM is an application
  33. for the management of your daily expense. It can also be used as a
  34. limited home financial package.
  35.  
  36. Some of the features are:
  37. DESKTOP
  38. *   Fully supports the desktop, with 3D look and feel,
  39. *   The graphical environment integrates the desktop and automates
  40.     the way you work.
  41. *   Multiple windows for reports and data entries.
  42. *   Window icon style toolbar.
  43. *   Iconification supported.
  44. *   Hotkey shortcut for commnly used functions.
  45.  
  46. TRANSACTIONS
  47. *   Number of transactions limited only by memory available.
  48. *   A maximum of 60 accounts and 60 categories giving a total of
  49.     over 300 combinations.
  50. *   Sort transactions by accounts, categories or date.
  51. *   Calculate expense automatically in display windows.
  52. *   Edit any transactions any time.
  53. *   Search any transactions.
  54.  
  55. GRAPHS
  56. *   Pie and bar charts.
  57. *   Graphs for account, categories and date groups.
  58. *   Graphs are self-scaling to fit windows.
  59.  
  60. REPORTS
  61. *   All reports are generated by report generator.
  62. *   Detailed transactions for specified date range, account type or
  63.     category type.
  64. *   Reports produced on-screen and can be printed or saved on disk.
  65. *   Budget reports can be generated for any accounts and categories.
  66.  
  67. GENERAL
  68. *   On-line help with ST Guide.
  69. *   Speedo GDOS support.
  70. *   Can be freely distributed.
  71. *   Mono and colour, ST/STe/Mega/TT and Falcon.
  72.  
  73. The concept
  74. ===========
  75. Accounts are created for credit cards, petty cash and anything else
  76. that is major enough to be tracked.  In general, money flows out
  77. from these so-called accounts.
  78.  
  79. Next there are categories. These are used to categorise the type of
  80. expenditure. Examples are Lunch, Dinner, Petrol, Diskettes etc. In
  81. general, these are the stuff that money is used on.
  82.  
  83. Actually the line between accounts and category in PHEM is
  84. blurred. There is no stopping from creating a Lunch account. However,
  85. by keeping the ccounts where money flows out from, a Budget can be
  86. kept.
  87.  
  88. A transaction is when money flow out from an account for a particular
  89. category. In PHEM, the date, amount of money and an comment
  90. are attached to a transaction. The comment can be anything that
  91. descript the transaction further ( example: Petrol @ 1.10/gallon ).
  92.  
  93. PHEM keeps the set of accounts, category and transaction
  94. as a book. It can then produce reports and charts of any accounts,
  95. category or transaction. This way the expense are tracked.
  96.  
  97. A budget can be kept for any accounts and category. Budget are
  98. calculated in a monthly basis. The Budget Report shows how much is
  99. left in the allocation for that particular month.
  100.  
  101.  
  102. Installating PHEM
  103. ====================
  104. 3 Easy Installation steps
  105. -------------------------
  106. 1/ Just unlzh the archive into any directory.
  107. 2/ Move the PHEM.HYP hypertext help file to your hypertext directory.
  108. 3/ Double click on the PHEM icon to run it.
  109.  
  110. Installing as a Application
  111. ---------------------------
  112. PHEM can be installed as an application for the .ACT files.In doing so
  113. you can run PHEM by double clicking on the .ACT file. Just make sure
  114. the default directory is the PHEM's home directory so that it can find
  115. the resource file.
  116.  
  117. Installing as a desktop icon application
  118. ----------------------------------------
  119. PHEM can be installed as a desktop icon. In doing so you can just drag
  120. a .ACT file on to it. Just make sure the default directory is the
  121. PHEM's home directory so that it can find the resource file.
  122.  
  123. The Menu Bar
  124. ============
  125. The menu bar consist of the following
  126.  * PHEM     for accessories and about.
  127.  * File     for file operations.
  128.  * Report   for reoprt and searching operations.
  129.  * List     for account, category and transactions operations.
  130.  * Entry    for entering transactions.
  131.  * Special  for other special operations.
  132.  
  133. * PHEM
  134. Selecting this menu title gives access to the desk accessories
  135. and also the About dialog.
  136.  
  137. * File
  138. selecting this menu title gives you access to
  139.   Open Book   - Read into memory an already created Book.
  140.   Save Book   - Save the book on to disk with the original name.
  141.   Save as     - Save the book on to disk, asking for a new name.
  142.   File Info   - Shows the name, creation and last modified date of the
  143.                 current file. A short description can also be entered
  144.                 in this dialog.
  145.   Import      - Any comma delimited text data file can be read in.
  146.                 The order of the data is critical, they are
  147.                     1st: year eg 1994
  148.                     2nd: month in months eg 1  ( for January )
  149.                     3rd: date
  150.                     4th: the account name
  151.                     5th: the category name
  152.                     6th: the comment
  153.                     7th: amount
  154.                 Example:  1994, 12, 8, Cash, Lunch, Soup, 1.65
  155.   Quit        - You guessed it! Quits PHEM.
  156.  
  157. * Report
  158. This dropdown menu provide access to the reporting tools.
  159.   Transaction - Calls up the Transaction Report Generator.
  160.   Account     - Calls up the Account Report Generator.
  161.   Category    - Calls up the Category Report Generator.
  162.   Budget      - Displays the Budget Report.
  163.   Find        - Calls up the Find/Search Dialog.
  164.  
  165. * List
  166. This dropdown menu provide access to the account manipulation tools.
  167.   Account     - Calls up the Account List.
  168.   Category    - Calls up the Category List.
  169.   Budget      - Displays the Budget List.
  170.   Merge       - Calls up the Merge Window for either account
  171.                 or category.
  172.  
  173. * Entry
  174. This dropdown menu provide access to the transaction entry tool.
  175.   Transaction - Calls up the Transaction Entry dialog.
  176.  
  177. * Special
  178.   System Info - Display information for the system. The memory
  179.                 indicates unfragmentated memory for the program
  180.                 to allocate.
  181.   Calendar    - Calls up the Calendar Window.
  182.   Reindex     - This sorts and reindex both the accounts and categories
  183.                 list to alphabetical order.
  184.   Configuration
  185.               - Calls up the Configure Window.
  186.  
  187. Transaction Report Generator
  188. ============================
  189. The Transaction report Generator determines the type of information
  190. and format that appears in the report.
  191.  
  192. Accounts and categories selection
  193.   Any accounts or categories can be selected to be included in the report.
  194.   They are selected in the account and category box.
  195.   - To scroll up or down the list, use the up and down arrow buttons.
  196.   - To select an entry, click on it to hilite it.
  197.   - To unselect a selected entry, click on it again.
  198.   - To select all the entries, press on the ALL button.
  199.     ( Note that ALL button will turn to a NONE button)
  200.   - To unselect all, press on the NONE button.
  201.  
  202. Sorting
  203.   The report can be sorted by date, account or category.
  204.   Chose by selecting the proper radio button.
  205.  
  206. Date range
  207.   The start and end of report date can be changed by clicking on the
  208.   particular date. A Calendar Window will appear for the selection of
  209.   the dates.
  210.  
  211. Subtotal / Summary / Details
  212.   This defines the type of report you want.
  213.   If subtotal or summary is selected, the groupings will be according to
  214.   the sorting method selected.
  215.  
  216. Display button
  217.   This will execute the form and the result will be displayed in the
  218.   Reprt Window.
  219.  
  220. Account / Category Report Generator
  221. ===================================
  222. The Account / Category report Generator will generate a subtotal report
  223. for the selected class type.
  224.  
  225. Class entry selection
  226.   Any accounts / categories can be selected to be included in the report.
  227.   They are selected in the account and category box.
  228.   - To scroll up or down the list, use the up and down arrow buttons.
  229.   - To select an entry, click on it to hilite it.
  230.   - To unselect a selected entry, click on it again.
  231.   - To select all the entries, press on the ALL button.
  232.     ( Note that ALL button will turn to a NONE button)
  233.   - To unselect all, press on the NONE button.
  234.  
  235. Date range
  236.   The start and end of report date can be changed by clicking on the
  237.   particular date. A Calendar Window will appear for the selection of
  238.   the dates.
  239.  
  240. Display button
  241.   This will execute the form and the result will be displayed in the
  242.   Reprt Window.
  243.  
  244. Budget Report
  245. =============
  246. The budget for four consequtive months are displayed in a window.
  247.  
  248. The delta column shows the sum of the 4 months result. This gives a
  249. simple quarterly result of the budget.
  250.  
  251. Any budget results that is negative will be printed out in red.
  252.  
  253. The budget for a account or category for a particular month is calculate
  254. by subtrating from it's allocated amount, the expenses incurred on that
  255. account or category for that month.
  256.  
  257. The allocated amount is entered via the Budget List tool.
  258.  
  259. Changing month/year of the budget
  260.   To change the month, click on the month popup button.
  261.   To change the year, click on the year popup button.
  262.  
  263. Filing
  264.   The report can be filed to a disk by clicking on the disk icon.
  265.   A fileselector will popup for the pathname. The report is saved in
  266.   ASCII format.
  267.  
  268. Printing
  269.   The report can be printed out on to the printer by clicking on the
  270.   printer icon.
  271.  
  272. Find/Search
  273. ============
  274. To find for a particular string in the comment field, use the Find
  275. dialog. The results of the find will display in a report window.
  276.  
  277. Wildcards are used to match occurance of string. The * is to match a
  278. sequence of characters while the ? is to match a single character.
  279.  
  280.     e.g  "abcdefghi" is the comment field
  281.            *ghi       will find the above field.
  282.            ??c??f*    will find the above field.
  283.            *dh*       will not find the above field.
  284.            *def       will not find the above field.
  285.  
  286. Account / Category List
  287. =======================
  288. The Account / Category window
  289.  
  290.   This window displays a list of all the entry in accounts or categories.
  291.  
  292. Selecting an account / category entry
  293.   To select a name to work on, click on the name. The entry will now be
  294.   hilited. You can use one of the icon on the window toolbar on it.
  295.   Selecting several entries to work on at one time is possible.
  296.  
  297. Add icon  (Keyboard shortcut - Insert key)
  298.   Pressing this icon will insert a new entry into the list.
  299.   A dialog for entering the new entry will appear.
  300.  
  301. Delete icon  (Keyboard shortcut - Delete key)
  302.   Pressing this icon will delete the selected entries of the list.
  303.   WARNING: Any transaction that reference this name will have it's
  304.            name listed as "* UNKNOWN *" in the reports.
  305.  
  306. Modify icon      (Keyboard shortcut - Retrun key)
  307.   Pressing this icon will modify the selected entries of the list.
  308.   A dialog for modifying the entry will appear.
  309.  
  310. Budget List
  311. ===========
  312. The budget list for four conseqcutive months are displayed in a window.
  313.  
  314. Entering budget data
  315. To make an entry into the budget list for a particular account or
  316. category, double click on the line that account or category
  317. is on. A dialog will appear for entry of the 4 months.
  318.  
  319. Modifying an entry
  320. To modify an entry into the budget list for a particular account or
  321. category, double click on the line that account or category
  322. is on. A dialog will appear for with data of the 4 months to be modified.
  323.  
  324.  
  325. Changing month/year of the budget
  326.   To change the month, click on the month popup button.
  327.   To change the year, click on the year popup button. A increment and
  328.   decrement popup will appear.
  329.  
  330. Filing
  331.   The listing as displayed can be filed to a disk by clicking on the
  332.   disk icon. A fileselector will popup for the pathname. The list is
  333.   saved in ASCII format.
  334.  
  335. Printing
  336.   The list can be printed out on to the printer by clicking on the
  337.   printer icon.
  338.  
  339. Merging Accounts or categories
  340. ==============================
  341. This function is to facilitate the combining of different accounts
  342. together and the combining of different categories together. This
  343. may be neccesary because a name on the list may need to be deleted.
  344.  
  345. Selecting the FROM entry
  346.   Use the POPUP BUTTON to choose the name to combine from.
  347.  
  348. Selecting the TO entry
  349.   Use the POPUP BUTTON to choose the name to combine to.
  350.  
  351. MERGE IT button
  352.   This will move all transactions with the FROM name to the TO name.
  353.  
  354. Transaction Entry
  355. =================
  356. The transaction window allows entries of transactions into the book.
  357. The follwoing information is required:
  358.   Account, Category, Date, and Amount.
  359.  
  360. Entering a transaction
  361. 1/ Use the account POPUP BUTTON to select the correct account.
  362. 2/ Use the category POPUP BUTTON to select the correct category.
  363. 3/ Click on the date to select correct date via the Calendar Window.
  364. 4/ Enter the amount.
  365. 5/ Enter a comment ( this is optional ).
  366. 6/ Click the ADD button to add to the transaction list.
  367.  
  368. The Modify Transaction Window is a Transaction Window without
  369. the recuring tickbox.
  370.  
  371. Recuring entries
  372. For recuring entries, tick on the recuring tickbox.
  373. A recuring entry dialog will appear where the following info is required:
  374.   The start date of the recurance via the Calendar Window.
  375.   The end date of the recurance via the Calendar window.
  376.   The frequency of the recurrance - daily, weekly or monthly.
  377.  
  378. Report Window Toolbar
  379. =====================
  380. Transactions that satisfy the criteria of Report Generator form are
  381. displayed in a Report window. The Report window contains a Toolbar.
  382. This Toolbar gives access to the Graph, Deleting, Exporting, Saving
  383. and Printing of the transactions displayed in the window.
  384.  
  385. To enter a new transaction Keyboar short cut - Insert
  386.  
  387. To select a transaction, just single click on it.
  388.  
  389. Modifying a transaction
  390. 1/ Double click on the transaction to be modified.
  391. 2/ A modify window will appear, this window is exactly the same as a
  392.    Transaction Entry window, it however does not have a recurring tickbox.
  393. 3/ Modify as required.
  394. 4/ Click on the MODIFY button to update the transaction.
  395. 5/ The Report window will be updated to reflect the changes.
  396.  
  397. Deleting a transaction    Keyboard shortcut - Delete
  398. 1/ Select the transacions to be deleted.
  399. 2/ Click on the DELETE icon, the window will be updated.
  400. 3/ A range of transaction can be selected and deleted in one step.
  401. WARNING: Deleting a transaction remove the transaction permanently.
  402.          It cannot be recovered.
  403.  
  404. Graphing the results
  405. Clicking on the Graph button will provide a graph for the transactions
  406. in the window. Both subtotal and summary results can be graphed.
  407. There is a choice between Bar Chart and a Pie Chart.
  408.  
  409. Exporting the results
  410. The transactions of the Report window can be exported out in comma
  411. delimited format. The format is similar to Import format.
  412.  
  413. Filing the result
  414. This files to disk the text of the window for use possibly in a word
  415. processor.
  416.  
  417. Printing the result
  418. This will printout the text of the window on a printer connected to
  419. the printer port.
  420.  
  421. Graphic Window
  422. ==============
  423. Well, this is the graphic window.
  424. You cannot do much about it, possibly GDOS printout capability in next
  425. release.
  426.  
  427. Creating a New Book
  428. ====================
  429. A new book can be created by starting up the program a fresh and
  430. begin entering the accounts, categories and entries.
  431.  
  432. Once a book is loaded, a new book will not be able to be created.
  433. When this happens, just quit the current session and start up a
  434. new session.
  435.  
  436. That was easy !!
  437.  
  438. Calendar Window
  439. ===============
  440. This small window display the current month.
  441.  
  442. To change the month, use the month POPUP button.
  443. To change the year, use the year POPUP button. An increment and
  444. decrement popup will appear.
  445.  
  446. To set the date
  447. 1/ Select the desired date by single clicking on it.
  448. 2/ click on the      button.
  449.           or
  450. 1/ Double clicking on the desired date.
  451.  
  452. NOTE: Only one date can be set at any one tine.
  453.  
  454. Reindexing
  455. ==========
  456. This reindexes the transactions witn the accounts and categories entries.
  457. The account and category lists are also sorted by this command.
  458.  
  459. System Info
  460. ===========
  461. Provides some information on the current system.
  462.  
  463. The Configure Window
  464. ====================
  465. This tool allows changing the colour and fills of the dialogs and the
  466. desktop. Changing any item will take effect immediately.
  467.  
  468. If SpeedoGDOS is installed, the font and font size of the report
  469. windows can be changed.
  470.  
  471. Ticking the "Print using GDOS" will output SpeedoGDOS fonts to the
  472. printer. Note that you must have previously installed a GDOS printer
  473. device driver.
  474.  
  475. The GUI
  476. =======
  477. PHEM uses an advance GUI for the ST/STE/TT and Falcon. The following
  478. tries to give an overview of the interface.
  479.  
  480. Iconification
  481. All windows can be iconified in all TOS version.
  482. For those TOS which support iconification use the button for it.
  483. For other TOS, to iconify a window, click the RIGHT mouse button on
  484. the window title bar.
  485.  
  486. Hot Keys
  487. Hot keys are keyboard shortcut for common functions.
  488. Menus:   Hot keys are display at the end of the menu item.
  489.          ^ means control     eg ^S means control-S
  490.          ◆ means altrenate   eg ◆T means alternate-T
  491.  
  492. Forms:   Hot keys are highlited by colour and/or underlined. To activate
  493.          press the Alternate key with the highlited character.
  494.  
  495. Windows: The Account List, Category List have Hot keys (shortcuts) for the
  496.          following: Insert = enter a new entry.
  497.                     Delete = removes the selected entries.
  498.                     Return = modify the selected entries.
  499.          The Report Windows have the Hot keys (shortcuts) for the following:
  500.                     Delete = removes the selected entries.
  501.  
  502. Window management
  503. Windows can be manipulated by hot keys.
  504. ESC        : Maximise / restore size  a window.
  505. Shift-ESC  : Close a window that does not have edit fields in it.
  506. Shift-Tab  : Iconify a window.
  507. Control-Tab: Cycle windows.
  508.  
  509. Development, History, acknowledgement, address
  510. ==============================================
  511. This program was developed on a 4Mb Tos 2.05 Mega STE with 170Mb HDD.
  512. Currently I am using a TV, my monitor is back home. I am not shipping
  513. my monitor for this. So if the screen looks funny, please feedback to
  514. me.
  515.  
  516. Software tools and package use:
  517.   Program  : Pure C, Pure Debugger and GUI provided by BIG 1.88.
  518.   Hypertext: Pure C (editor), ST-Guide and HCP
  519.  
  520. History
  521. Ver 1.0:  Released to the public as freeware.
  522. Ver 2.0:  Released to the public as freeware.
  523.           - Budget capability.
  524.           - SpeedoGDOS support.
  525.           - Icons in toolbar.
  526.           - Regroup menu items to be more logical.
  527.           - Retouch some dialogs to improve functionality.
  528.           - Configurable Look & Feel for desktop.
  529.           - Fixed calendar completion dialog bug.
  530.  
  531. Feedback
  532.   Please send feedback of any types to:
  533.     Internet : wongck@lobby.ti.com
  534.  
  535.     Mail : William Wong
  536.            Blk 148, Potong Pasir Ave 1,
  537.            #04-63, S(1335),
  538.            Republic of Singapore.
  539.  
  540.            William Wong                This address valid till
  541.            2600 Preston Road,          April 1995
  542.            Apt 1009,
  543.            Plano, Texas 75093
  544.            USA
  545.  
  546. Acknowledgement
  547. Borland Germany for the excellent Pure C and Pure debugger.
  548. Claude Attard   for the cool BIG libraries.
  549. Holger Weets    for the great ST-Guide and HCP software.
  550. My students     for the interpretation.
  551.  
  552.